<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/shared_name.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">shared_name.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="shared__name_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name__fwd_8hpp.html">ipc/util/shared_name_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="common_8hpp.html">ipc/common.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">/**</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * entity from all others in the system, or a fragment of such a name.  Conceptually it relates to `std::string`</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * similarly to how `filesystem::path` does.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> *</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * This is a very simple class in terms of what logic it actually adds: it encapsulates an `std::string` and allows for,</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * basically, string operations like concatenation, with some syntactic sugar added for a simple *folder* convention.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * However, the design *context* (namely, how shared resources are named and why) is less trivial, and this doc header</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * is a good place to get into those topics as well.  Hence, we first cover practical aspects, with the architectural</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * context referenced only as needed.  Then, below that, there&#39;s an architecture discussion about naming in general.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> *</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * ### Construction/assignment from and conversion to strings/similar ###</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * Interanally it stores an `std::string`.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * Conversion: That `string` is accessible by `const&amp;` via str() and similarly the NUL-terminated native_str().</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * Also there is an `ostream&lt;&lt;` printer; do note it does not simply print str() but rather a beautified version.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * (`ostream&gt;&gt;` input is also provided but is identical to `ostream &gt;&gt; string`.)</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * Construction/assignment: It comes with standard default/copy/move ctors and assignment.  There is also a</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * constructor that takes two iterators-to-`char` (including 2 `const char*`).  However, construction</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * from `string` (including destuctive move-construction), util::String_view, NUL-terminated `const char*`,</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * `vector&lt;char&gt;` (etc.) is available exclusively in the form of `static` quasi-ctors ct().  Lastly: To assign please</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * use move ctor: `existing_sh_name = Shared_name::ct(src)`.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * Rationale: C++ ADL semantics cause a ton of super-annoying problems -- especially inside ipc::transport</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * namespace itself -- where compilers will auto-convert, e.g., a `string` to `Shared_name` without being asked</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * to do so at all.  For example, one sees `operator &lt;&lt; string` output the `string` in &quot;beautified&quot; form, because</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * a `Shared_name` is constructed implicitly and then printed via its `&lt;&lt;`.  I (ygoldfel), then, took a cue from</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * boost.asio&#39;s IP address classes which use `static` quasi-ctors to avoid any such issues.  (The alternative</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * was to fine-tune the ctor set a-la `filesystem::path`, with conversion traits and all kinds of craziness.)</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * ### Practical Shared_name matters ###</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * A *shared resource* in this context is some entity (such as a SHM-mapped addressable area; or a POSIX message queue)</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * that can be *opened* for further access by potentially 2+ processes simultaneously.  When opening (at least),</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * the shared resource is referred to -- in the associated opening sys call or similar -- by a string name, and the name</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * works equally from those 2+ processes.  Shared_name stores such a string.  It is also suitable for *fragments* of</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * these names, including prefixes, suffixes, or middle parts.  Therefore -- much like `boost::filesystem::path` is</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * basically a string wrapper -- Shared_name is just a string wrapper.  In fact the `std::string` it stores is</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * accessible through str() by reference.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * All standard string-like operations (generally, the `+=`, `/=`, `+`, and `/` operations) are equally performant and</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * not *any* smarter than the corresponding string concatenation ops (the `/` variants just add a separator character).</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * The same holds for all operations, except see the next section.  In particular, all characters are allowed in any</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * position, and there is no max length enforced.  Hence, the user may assume max possible performance and zero</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * restrictions, with the exception of:</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * ### Conventions understood/enforced by Shared_name ###</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * As noted, generally the class allows everything and does nothing smart that `std::string` wouldn&#39;t do.  This is for</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * flexibility and performance and is inspired by `boost::filesystem::path`.  However, there is *optional* support</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * for some simple conventions.  First let&#39;s discuss those conventions:</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * In Flow-IPC, Shared_name is to be used for all shared resource *types* needed.  (These are not enumerated here.)</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * Different resource types might have different rules for (1) characters allowed; and (2) max length allowed; so that</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * if this is violated, a creation/opening sys call (or similar) will fail with an error.  Therefore, the following</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * *conventions* are understood and represent the *union* of known system restrictions, so that sanitized()</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * names will work for *all* known resource types.  Also, some conventions are for human usability.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * In total, these conventions are understood:</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *   - Only certain characters are allowed.  Namely, only alphanumerics [A-Za-z0-9] are allowed as of this writing.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *   - There is a *folder* convention: We anticipate a file tree-like organization of various items; hence a</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *     folder separator character, #S_SEPARATOR, is allowed also.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> *     - A complete, usable (in a sys call or similar) name is to start with one leading #S_SEPARATOR.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> *     - We anticipate no empty &quot;folder&quot; names; and therefore no sequences of 2+ adjacent #S_SEPARATOR chars.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *   - Names shall not exceed a certain max length.  #S_MAX_LENGTH is chosen to be low enough to work for all supported</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *     resource types.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * How does Shared_name actually *use* the knowledge of these conventions?  To reiterate: normally, it does not care.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * The only parts of its API that *do* care are as follows:</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *   - absolute() will return `true` if and only if the first char is #S_SEPARATOR.  By convention, you should not</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *     pass str() to a sys call/similar, unless `absolute() == true`.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *   - sanitized() will return `true` if and only if str() is a valid name or name fragment (no illegal characters;</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *     does not exceed #S_MAX_LENGTH; no multi-separator sequences).</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *   - sanitize() will attempt to non-destructively modify (if needed) name in such a way as to make sanitized() return</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *     `true`.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * You should call them only when you specifically need some conventions checked or enforced.  Otherwise Shared_name</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * ops will be as dumb/fast as possible.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * @note The Flow-IPC library *user* is unlikely to directly pass a Shared_name into a sys call or similar.  Probably</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *       Flow-IPC internals will do it for the user.  Therefore, the likeliest pattern for the user to encounter in</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *       public Flow-IPC APIs is: When initially naming some `transport` object, a constructor or factory will take</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *       a *relative* (`absolute() == false`) Shared_name prepared by the user.  Within that relative fragment,</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *       the user is to use the folder conventions above (via `/=` or `/` operators perhaps) if needed.  Inside</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *       Flow-IPC, the impl can then construct an absolute name by internally pre-pending stuff to the</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *       user-constructed fragment. If you have ensured the name is sanitized(), then it will not fail on account of a</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> *       bad name.  If you have *not*, then it may still not fail: sanitized() is a conservative criterion and may be</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *       too stringent for some resource types and OS calls.  It is up to *you* to either ensure sanitized() or</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> *       otherwise worry about the possibility of a bad name (illegal characters, excessive length).</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * Shared_name has the same safety under concurrency as `std::string` (i.e., if you intend on writing while</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * reading/writing same `*this` concurrently, synchronized access is necessary to avoid corruption and other standard</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * thread safety violations).</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * ### Architecture discussion / shared name convention synopsis ###</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * As promised, we&#39;ve covered the practical aspects of Shared_name first.  Now let&#39;s discuss the larger design.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * Note that while this does inform some of Shared_name API (which is quite simple), really the discussion has wider</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * implications, and this doc header merely seems like a good place for it.  It would&#39;ve been okay to split off</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * much of the below info into ipc::session somewhere, but... maybe that&#39;s better... but the human in me (ygoldfel)</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * feels you&#39;ll want to know this now, here, even though for formal appropriateness maybe it should be moved.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * In any case here it is:</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * As noted before, there are N shared resource types, and Shared_name is to be used for all of them.  At minimum,</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> * then:</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *   - 2 names are to be equal if and only if they refer to the same object of the same type, or they&#39;re 2 different</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> *     objects but of *different* types.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *   - This must be the case at each given point in time.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * When designing Flow-IPC, we decided that if would be helpful for humans if we immediately made this more stringent</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * by enforcing the following stronger requirement as well:</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *   - 2 names are to be equal if and only if they are referring to objects of the same (resource) type.  So then,</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *     e.g., if a SHM-area is named &quot;X&quot; then a POSIX queue cannot also be named &quot;X&quot; at the same point in time.</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * Further, some things are made easier if the distinctness restriction (2 distinct names &lt;=&gt; 2 distinct objects</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> * at each given point in time) is made more stringent by extending it to *all time*; resulting in:</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *   - 2 names are to be equal if and only if they refer to the same object of the same type.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *   - This must be the case over all time (not merely a each *given* point in time).</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *     - In other words, if a name &quot;X&quot; is used for some object of some type, then it&#39;s only *ever* used for that</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *       object and never another (until reboot).</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> * @note Shared resources are assumed to be *kernel-persistent*, which means the slate is wiped with each system boot.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *       Hence &quot;all time&quot; really means &quot;within the relevant uptime.&quot;</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * Practically speaking, then, how do we enable these distinctness guarantees, in absolute names (i.e., names to be</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> * passed, usually internally by Flow-IPC, into sys calls/similar)?  Firstly, the resource type for the object</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * referred to by each absolute name should be encoded in a standard prefix inside the name; a simple distinct constant</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * for each resource type works.  There should be a handful at most of these possible values.  This will guarantee</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * non-clashing between different types of resource.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> *</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * That only leaves the distinct-across-all-time requirement.  However, it&#39;s outside the scope of this header to</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * explain how that&#39;s achieved, as it involves ipc::session and other concepts and is just a large topic.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> *</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * For convenience, we now summarize the resulting absolute shared name convention, as of this writing, without a full</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * rationale and with references to other doc headers if appropriate.  In order, the characters of a shared name</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * in the Flow-IPC convention are as follows.  Use session::build_conventional_shared_name() to construct a</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * path with these semantics.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> *</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *   -# Leading #S_SEPARATOR.  Indicates a full (absolute) name or prefix thereof.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *   -# A certain constant magic string, #S_ROOT_MAGIC, indicating ::ipc is operating.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *      (E.g., if... uh... emacs likes to put stuff in, say, SHM, at a certain SHM path, hopefully it won&#39;t clash</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *      with us accidentally.)</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *   -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *   -# Hard-coded resource type constant.  Indicates resource type.  E.g., something like &quot;posixq&quot; might mean a</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *      POSIX message queue.  The (quite few) possible values for this are stored internally in Flow-IPC.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *   -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *   -# Session-server application name.  This brief name is 1-1 with all distinct executables supported by Flow-IPC.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *      See ipc::session for details.</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *   -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *   -# Server-namespace.  This uniquely identifies the server application *instance* across all time, for a given</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *      session-server application name.  See ipc::session for how this value is computed.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *      In the rare case where the resource applies to *all* server-namespaces, use special value #S_SENTINEL.</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *   -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *   -# What comes next depends on the *scope* of this particular resource.</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *      - Relevant to a given session A-B (where A and B are processes that can converse with each other),</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *        a/k/a *per-session scope*:</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> *        -# Session-client application name.  Analogous to session-server application name but for the supported</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *           clients.  See ipc::session for details.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *        -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *        -# Client-namespace.  Given everything up to this point, uniquely identifies client application *instance*</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *           across all time (like server-namespace above, basically).  See ipc::session for how it&#39;s computed.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *      - Relevant to no particular process pair A-B, but does apply only to a given session-client application,</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *        a/k/a *per-client-app scope*:</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *        -# Session-client application name, as just above.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *        -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *        -# The reserved client-namespace, #S_SENTINEL, indicating no particular session-client.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> *      - Global (not limited to any smaller scope above), a/k/a *global scope*.  This is intended largely for</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> *        internal Flow-IPC needs, as of this writing.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> *        -# The reserved session-client application name, #S_SENTINEL, indicating no particular client application.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> *   -# A #S_SEPARATOR.</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> *   -# The rest of the name depends on the convention decided for that particular resource type and hence outside</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *      our scope here; see doc header for the relevant class corresponding to a shared resource type of interest.</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> *      - For each object, determine the *scope* (the 3 possibilities and resulting naming conventions are just above).</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> *      - Keep using the basic folder convention, with non-empty folder names and #S_SEPARATOR as separator.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> *      - When uniqueness is desired, the `1`-&gt;`2`-&gt;`3`... technique is typically used (always remembering that</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> *        such an auto-ID must be safely generated across all participating processes in system).</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> *</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * In rare cases a Shared_name will be used outside the ipc::session paradigm, such as for a lower-level purpose</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * that nevertheless requires a shared-resource name (e.g., for a lower-level-use SHM pool).  In that case</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * the following shall be equal to #S_SENTINEL: session-server application name; server-namespace.  The components</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * subsequent to that shall be as-if it&#39;s a global-scope resource; hence: #S_SENTINEL.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * build_conventional_non_session_based_share_name() shall construct such a name.</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * @note *camelCase*: As of this writing, #S_SEPARATOR is `_` (because `/` is not available for native reasons).</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> *       So, when it comes up, the convention is to use camelCase for tokens between nearby separators.  Briefly:</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> *       start with lower case; do not word-smoosh; each new word after word 1 is to begin with exactly 1 capital or</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *       number; an acronym is to be treated as a single word.  Examples of compliant tokens:</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> *       `httpUrlConnectionV44Beta`, `tableIdent`.  These are bad: `httpURLConnection` (wrong acronym convention),</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> *       `HTTPURLConnection` (ditto), `tableident` (word-smooshing).</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> *</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> * ### Rationale for max length handling ###</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> * As noted in the public section of this doc header: #S_MAX_LENGTH is a part of sanitized() criteria; it is not</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> * enforced by Shared_name itself outside of sanitized() and sanitize().  It is up to the Shared_name user (which</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * may, and usually is, internal Flow-IPC code) to actually ensure sanitized() is `true` -- or otherwise avoid system</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> * API errors on account of bad names.  All *we* choose to do, regarding the length aspect, is choose one conservatively</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> * low so that:</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *   - At least it is no greater than the *lowest* inherent limit out of all the known resource types to which</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> *     Shared_name apply.</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *   - Additionally, because in many cases a given `public` API takes a relative Shared_name and pre-pends an</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> *     absolute &quot;folder&quot; path of known length, further leave slack to make it so that that prefix can still comfortably</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> *     fit without hitting the limit from the previous bullet point.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> *</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> * To wit, then, current tally of relevant resource types:</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> *     - POSIX message queue (`man mq_overview`): Linux: An internal forward-slash, included in `NAME_MAX = 255`</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> *       characters including NUL; so apparently: 253.  (The `man` text could be interpreted as meaning 253, 254, 255;</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> *       it is ambiguous.  Experiments show it&#39;s 253.)</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> *     - SHM pool (ultimately: `man shm_open`): Linux: Same as preceding: 253.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> *     - bipc message queue (search: boost.interprocess `message_queue`): It just opens a SHM pool per MQ; so</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> *       same as preceding: 253.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"> *     - Unix domain sockets (ultimately: `man unix`): Linux, abstract namespace: It&#39;s a hairy topic.  `sun_path[108]`</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"> *       is the case as of this writing; minus 1 leading and trailing NUL; and there&#39;s a note some (non-Linux?) Unix</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"> *       domain socket implementations go as low as `sun_path[92]`.  But in Linux: 106.</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"> *</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment"> * So that puts us at 107 without the &quot;prefix slack.&quot;  Applying a prefix slack of 32 characters gives us: 107 - 32 =</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment"> * 75.</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"> */</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html">  241</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span>{</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment"></span> </div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">  /// A (default-cted) Shared_name.  May be useful for functions returning `const Shared_name&amp;`.</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a5bbfb4d3b378cf7b9a1bcaf5d6c5a067">  247</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a5bbfb4d3b378cf7b9a1bcaf5d6c5a067">S_EMPTY</a>;</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment"></span> </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   * Max value of size() such that, if str() used to name a supported shared resource, sys call safely won&#39;t barf.</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   *</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * @todo Shared_name::S_MAX_LENGTH currently applies to all shared resource types, but it&#39;d be a useful feature to</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * have different limits depending on OS/whatever limitations for particular resources types such as SHM</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * object names versus queue names versus whatever.</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * @todo Research real limits on Shared_name::S_MAX_LENGTH for different real resource types; choose something for</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * MAX_LENGTH that leaves enough slack to avoid running into trouble when making actual sys calls; as discussed in</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * the at-internal section of Shared_name doc header about this topic.  Explain here how we get to the</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * limit ultimately chosen.  The limit as of this writing is 64, but real research is needed.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   */</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#afc9b87fc69d42df3107bf4a27ea66c7c">  263</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#afc9b87fc69d42df3107bf4a27ea66c7c">S_MAX_LENGTH</a>;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment"></span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">  /// Character we use, by convention, to separate conceptual folders within str().</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a5c0910497c5ec484d3e42dfb0ccad48d">  266</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a5c0910497c5ec484d3e42dfb0ccad48d">S_SEPARATOR</a>;</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment"></span> </div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * A Shared_name fragment, with no #S_SEPARATOR characters inside, to be used in any Shared_name maintained by</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * ::ipc itself as the leading path component.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   */</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#af08b45aa719d4f5dced595cca39ab2c8">  272</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#af08b45aa719d4f5dced595cca39ab2c8">S_ROOT_MAGIC</a>;</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment"></span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * A Shared_name fragment, with no #S_SEPARATOR characters inside, that represents a path component that shall</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * be different from any other generated string at the same path depth in the same context; and represents</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * a sentinel.  In actual fact it equals `0`; and typically (though not necessarily -- other conventions may exist)</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * generated strings shall be `1`, `2`, ..., of which the former is #S_1ST_OR_ONLY.</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   */</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">  280</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">S_SENTINEL</a>;</div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment"></span> </div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   * A Shared_name fragment, with no #S_SEPARATOR characters inside, that represents a path component that</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * (1) is not #S_SENTINEL and (2) is suggested as the *first* or *only* unique ID of</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   * items at the same depth in the same context.  In actual fact it equals `1`; and typically (though not</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * necessarily -- other conventions may exist) generated strings shall be `1`, `2`, ..., of which</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * the former is #S_1ST_OR_ONLY.</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   *</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * So if #S_SENTINEL means &quot;not a thing&quot; or &quot;special thing to be treated not like a normal thing&quot;,</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * then #S_1ST_OR_ONLY means &quot;a normal thing, of which there may be only one, and this is the first one</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * so created.&quot;</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   *</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * ### Suggested use pattern ###</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * This is most useful when, at this path level, you currently only have reason to have one object.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * Then you can name it #S_1ST_OR_ONLY without relying on a magic string `1`.  However, if in the future</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * there is reason to add more objects at the same level, then remove the use of `S_1ST_OR_ONLY` and instead</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * use a `uint` or `atomic&lt;uint&gt;` data member that starts at simply the numeric `1`, `++`ing it each time a</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * new object is added (and converting it via `Shared_name::ct(std::to_string(x))` to string).</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * The first object will have the same name as before, compatibly, while subsequent ones will be</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * efficiently named uniquely.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   * Is this cheesy and reliant on the fact that this constant is, in fact, a string conversion of the number one?</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * Yes, but the above pattern works and is reasonably efficient.  I (ygoldfel) considered making this</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * a super-general API that keeps generating unique IDs, but it just seemed like overkill given the simplicity</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * of the task.  Converting back from Shared_name, generating a new `++`ed one, then converting back -- while</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   * providing a simple-enough API to ensure atomicity -- seemed inferior to just letting people</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   * maintain a compatible `atomic&lt;uint&gt;`, when and if desired, and using #S_1ST_OR_ONLY until then.</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   */</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#aaa78ddb3efa5abe4fa80058dedbef68c">  309</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#aaa78ddb3efa5abe4fa80058dedbef68c">S_1ST_OR_ONLY</a>;</div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment"></span> </div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">  /// Relative-folder fragment (no separators) identifying the resource type for: SHM pools.</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a4c294e23753eb706b4c297d99d24cd48">  312</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4c294e23753eb706b4c297d99d24cd48">S_RESOURCE_TYPE_ID_SHM</a>;</div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"></span> </div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">  /// Relative-folder fragment (no separators) identifying the resource type for: boost.interprocess named mutex.</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a50cb5d2ad8f8b4391e1885e7b8f63890">  315</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a50cb5d2ad8f8b4391e1885e7b8f63890">S_RESOURCE_TYPE_ID_MUTEX</a>;</div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span> </div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment"></span> </div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">  /// Constructs empty() name.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a1f9b706d587b49ad84b555817c001fc8">  320</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1f9b706d587b49ad84b555817c001fc8">Shared_name</a>();</div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment"></span> </div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * Copy-constructs from an existing Shared_name.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   *</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   */</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a1e9cad5a94d78e1180a9e77877009873">  328</a></span>  <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1e9cad5a94d78e1180a9e77877009873">Shared_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src);</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment"></span> </div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   * Move-constructs from an existing Shared_name, which is made empty() if not already so.</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   * @param src_moved</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *        Source object, which is potentially modified.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   */</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a79995ab36be778bb2a56eeba80a7abed">  336</a></span>  <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a79995ab36be778bb2a56eeba80a7abed">Shared_name</a>(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; src_moved);</div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment"></span> </div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   * Copy-constructs from a `char` range given as a pair of random-iterators; in particular `const char*`s work.</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   *</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   * @tparam Input_it</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   *         An STL-compliant random iterator type.  In particular `const char*` works.</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * @param begin</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   *        Start of range to copy.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   * @param end</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *        One past last element in range to copy (`begin` to copy nothing).</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   */</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Input_it&gt;</div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1f9b706d587b49ad84b555817c001fc8">Shared_name</a>(Input_it begin, Input_it end);</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span> </div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span>  <span class="comment">// `static` ctors.</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment"></span> </div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * Copy-constructs from a `char`-sequence container (including `string`, util::String_view, `vector&lt;char&gt;`).</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * This overload shall be used on a non-`&amp;&amp;` arg if `ct(const char*)` does not apply.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * Specifically the returned object&#39;s internal `std::string` is constructed as: `std::string s(raw_name)`.</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * As a result, whatever most-performant available single-arg ctor `basic_string` makes available is forwarded-to.</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * (E.g., C++17 has a `String_view_like` ctor which is overload-resolved-to only when it most makes sense.)</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   *</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * See class doc header for rationale as-to why this is a `static` ctor as opposed to a regular ctor.</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * @tparam Source</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   *        String to copy.</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   * @return The new object.</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   */</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span>  <span class="keyword">static</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">ct</a>(<span class="keyword">const</span> Source&amp; src);</div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment"></span> </div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * Copy-constructs from a NUL-terminated `const char*` string.</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   *</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * See class doc header for rationale as-to why this is a `static` ctor as opposed to a regular ctor.</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   *</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * @tparam Source</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   *        String to copy.</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * @return The new object.</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   */</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>  <span class="keyword">static</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">ct</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* src);</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment"></span> </div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * Destructively move-constructs from an `std::string`, emptying that source object.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   *</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   * See class doc header for rationale as-to why this is a `static` ctor as opposed to a regular ctor.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   *</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * @param src_moved</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   *        String to move (make-`.empty()`).</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * @return The new object.</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   */</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span>  <span class="keyword">static</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">ct</a>(std::string&amp;&amp; src_moved);</div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span> </div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment"></span> </div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   * Copy-assigns from an existing Shared_name.</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   */</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#abd312f9eaf6f07adaba115aaab05b539">  408</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#abd312f9eaf6f07adaba115aaab05b539">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src);</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"></span> </div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * Move-assigns from an existing Shared_name.</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   *</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * @param src_moved</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   *        Source object, which is potentially modified.</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   */</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a1511bd84d701dd866029d0f4c8869516">  417</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1511bd84d701dd866029d0f4c8869516">operator=</a>(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; src_moved);</div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment"></span> </div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * Returns (sans copying) ref to immutable entire wrapped name string, suitable to pass into sys calls when naming</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   * supported shared resources assuming `absolute() == true`.  If you require a NUL-terminated string (such as for</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * a native call), use native_str().</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   * @note Returning a util::String_view seemed pointless, as one can always be constructed easily by the caller, and</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   *       in any case -- for the time being at least -- some/many APIs that take non-C-strings will take `std::string`</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   *       as opposed to a util::String_view.</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   *</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   */</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span>  <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ae89e1e061f87ffe0288514e254837595">str</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment"></span> </div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * Returns (sans copying) pointer to NUL-terminated wrapped name string, suitable to pass into sys calls when naming</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * supported shared resources assuming `absolute() == true`.  If you require an `std::string` (such as for some fancy</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   * boost.interprocess call) See also str().</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   *</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   * ### Why isn&#39;t it named `c_str()`? ###</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   * It was, but `capnp::StringPtr` (and similar/derived classes such as `capnp::Text::Reader`) has a &quot;clever&quot;</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   * `operator T()` conversion operator that is enabled for all `T` that have `.c_str()`; and its implementation</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * relies on being able to symmetrically construct `T(const char*)` -- like `std::string`.  We intentionally</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   * lack that.  Hence renamed this away from `.c_str()`.  This may appear like kow-towing to capnp&#39;s quirks,</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * but actually conceivably that&#39;s a pattern people use, so let&#39;s not break it.</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   *</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   */</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a0bccc73c9c5b4f3b784a1e57cdc5c910">native_str</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment"></span> </div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   * Returns `str().size()`.</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   */</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#af34db2934e116f8a4fdd403fd04695af">size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment"></span> </div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   * Returns `true` if and only if `str().empty() == true`.</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   */</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a861ea6c9ad6672e83bab5c7747b66f7b">empty</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment"></span> </div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">   * Returns `true` if and only if `!this-&gt;empty()`, and str() ends with the #S_SEPARATOR character.</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   */</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a774e872b51100b728e0780b39f563ed9">has_trailing_separator</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment"></span> </div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * Returns `true` if and only if the first character is #S_SEPARATOR.  By Flow-IPC convention, any name actually</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * passed to a sys call in order to name a shared resource has `absolute() == true`.  Note, however, that absolute()</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   * being `true` does not necessarily mean str() is the full name of a resource: it may well still be a fragment</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * (a prefix) of some eventual name passed to a sys call.  To obtain the full name one would append more stuff.</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   *</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   */</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ab1934f80515fdbc3e2a59ccda32fff9a">absolute</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment"></span> </div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">  /// Makes it so `empty() == true`.</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment"></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a8328c9a6bc2739145087515ee8e677d8">clear</a>();</div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment"></span> </div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   * Returns `true` if and only if the contained name/fragment is *sanitized* according to length, legal characters,</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   * and similar.  More precisely, a sanitized `*this` satisfies all of the following:</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   *   - There are no illegal characters.  (E.g., in particular, some characters would not be accepted when naming</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   *     a SHM object in Linux.)</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   *     - In particular, only #S_SEPARATOR is used as a folder separator.</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   *   - There is no more than 1 instance of #S_SEPARATOR character in a row.</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   *   - size() does not exceed #S_MAX_LENGTH.</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   *</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   * ### Performance ###</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * It is linear-time, with at most one scan through str().</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   */</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a03d90faae35392c8bbdd22f056755ba9">sanitized</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment"></span> </div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * Best-effort attempt to turn sanitized() from `false` to `true`, unless it is already `true`; returns the final</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * value of sanitized() indicating whether it was successful.  If `false` returned, then the final value of str()</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   * will equal the initial value.</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   *</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   * This utility should be used very judiciously and with full knowledge of what it actually does.  It should *not* be</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * used &quot;just in case&quot; or &quot;prophylactically&quot; but only with full knowledge of where the current value of str() might</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   * originate.  For example, it might come from some user input.  Another example involves, perhaps, concatenating</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   * two path fragments in such a way as to potentially yield a double-#S_SEPARATOR situation: sanitize() after this</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * would get collapse the separators into just 1 separator.  Yet another example is simply that if one combines</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * two paths which don&#39;t exceed #S_MAX_LENGTH, but the result might exceed it: running sanitize() and ensuring it</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   * returns `true` guaranteed one didn&#39;t accidentally exceed #S_MAX_LENGTH.</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   *</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   * In other words, use it when you want it to do what it, in fact, does.  And that is:</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   *   - Any &#39;/&#39; (forward-slash) character, as a special case, is transformed into #S_SEPARATOR.</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   *   - After any character replacements above: Any sequence of 2 or more #S_SEPARATOR characters is collapsed into</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   *     one #S_SEPARATOR.</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   *</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   * Things it does *not* do, except the above:</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   *   - No legal or illegal character is changed (except &#39;/&#39; and separator collapsing).</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   *   - It doesn&#39;t truncate to try to bring length to #S_MAX_LENGTH or less.</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   *</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   * However, the method&#39;s return value is still significant, in that if it is &quot;still&quot; `false`, then you know you have</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * a real problem -- yet if it&#39;s `true`, then it didn&#39;t do anything destructive to make it so.</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   *</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * Note, again, that the above replacements are &quot;undone&quot; if `false` is returned.  In other words, the function</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   * won&#39;t sanitize &quot;halfway.&quot;</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   *</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * ### Performance ###</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   * There is at most one linear scan through str().  In addition, though only if actual sanitizing (by changing</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   * str()) might be necessary: an allocation, copy of str(), and deallocation may be performed.</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   * Overall, it is linear-time regardless, plus those potential alloc/dealloc ops.</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   *</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   * @return What sanitized() would return just before returning from the present function.</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   */</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#add4ed045e03f786427a236a5dfa5a1b0">sanitize</a>();</div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment"></span> </div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   * Appends a folder separator followed by the given other Shared_name.</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   * Functionally equivalent to `return *this += (string(1, S_SEPARATOR) + src_to_append.str());`.</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   * If there&#39;s any reason to suspect `this-&gt;str()` already ends in #S_SEPARATOR, and/or that the resulting name</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   * might be too long, execute sanitize() afterwards and ensure that returns `true`.</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   *</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   * It is stylistically (and possibly for performance) better to use this rather than manually appending</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   * a separator and then `src_to_append` (with `+=`).</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   *</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   * ### Rationale for not doing something smarter like avoiding a double-separator due to concatenation ###</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   * Basically we want things to be as fast as possible by default; and that is to make it as close to trivial</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   * string concatenation as possible.  If more paranoia is required, we want the user to intentionally use</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   * sanitize() or sanitized().</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   *</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * @param src_to_append</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   *        Thing to append after appending separator.</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   *</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * ### Rationale for having this `/=` as opposed to only the version taking `Source`, or vice versa ###</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   * If we had only the one taking Shared_name, then tried to use `+= X`, where `X` is `std::string` or `const char*`</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   * or util::String_view, it&#39;d have to (implicitly) construct a Shared_name first, and that is a bit slower.</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   *</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   * If we had only the one taking `Source` (e.g., `String_view`), and user wanted to append a Shared_name, they&#39;d</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   * have to use `X.str()` explicitly, losing a bit of syntactic sugar.</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   *</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   * Same deal with `+=` and the binary (`+`, `/`) derivations of these.</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   */</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a956fdac1bb4cfab414b30091bec43f70">operator/=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src_to_append);</div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment"></span> </div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">   * Simply appends a folder separator followed by `raw_name_to_append` to the current value of str().</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">   * Specifically the internal `std::string` is modified as: `s += S_SEPARATOR; s += raw_name_to_append`.</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * As a result, whatever most-performant available (single-arg by definition) `operator+=` that `basic_string`</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   * makes available is forwarded-to for the 2nd `+=`.  (E.g., C++17 has a `String_view_like` appender which is</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * overload-resolved-to only when it most makes sense.)</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   *</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   * If there&#39;s any reason to suspect `this-&gt;str()` already ends in #S_SEPARATOR, and/or that the resulting name</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   * might be too long, execute sanitize() afterwards and ensure that returns `true`.</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   *</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * It is stylistically (and possibly for performance) better to use this rather than manually appending</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   * a separator and then `src_to_append` (with `+=`).</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   *</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><span class="comment">   * See Rationale(s) for the other operator/=(), as they apply here.</span></div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span><span class="comment">   *</span></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span><span class="comment">   * @tparam Source</span></div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">   * @param raw_name_to_append</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="comment">   *        Thing to append after appending separator.</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">   */</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a956fdac1bb4cfab414b30091bec43f70">operator/=</a>(<span class="keyword">const</span> Source&amp; raw_name_to_append);</div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment"></span> </div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   * Similar to the overload that takes `const Source&amp;`, but takes NUL-terminated string instead.  See that doc header.</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   *</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   * @param raw_name_to_append</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">   *        Thing to append after appending separator.</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">   */</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a956fdac1bb4cfab414b30091bec43f70">operator/=</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* raw_name_to_append);</div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment"></span> </div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">   * Appends the given other Shared_name.</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   * Functionally equivalent to `return *this += src_to_append.str());`.</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   * If there&#39;s any reason to suspect the resulting name might be too long, execute sanitize() afterwards and ensure</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * that returns `true`.</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   *</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * It is stylistically (and possibly for performance) better to use `/=` rather than manually appending</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   * a separator and then `src_to_append` (with this `+=`).</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   *</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   * See Rationale(s) for operator/=(), as they apply here.</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   *</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   * @param src_to_append</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   *        Thing to append.</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   */</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">operator+=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src_to_append);</div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment"></span> </div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   * Simply appends `raw_name_to_append` to the current value of str().  Specifically the internal</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   * `std::string` is modified as: `s += raw_name_to_append`.  As a result, whatever most-performant available</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   * (single-arg by definition) `operator+=` that `basic_string` makes available is forwarded-to.</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">   * (E.g., C++17 has a `String_view_like` appender which is overload-resolved-to only when it most makes sense.)</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment">   *</span></div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">   * If there&#39;s any reason to suspect the resulting name might be too long, execute sanitize() afterwards and ensure</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   * that returns `true`.</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   *</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   * It is stylistically (and possibly for performance) better to use `/=` rather than manually appending</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   * a separator and then `src_to_append` (with this `+=`).</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   *</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">   * See Rationale(s) for operator/=(), as they apply here.</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span><span class="comment">   *</span></div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span><span class="comment">   * @tparam Source</span></div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">   * @param raw_name_to_append</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   *        Thing to append.</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   */</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">operator+=</a>(<span class="keyword">const</span> Source&amp; raw_name_to_append);</div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><span class="comment"></span> </div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment">   * Similar to the overload that takes `const Source&amp;`, but takes NUL-terminated string instead.  See that doc header.</span></div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment">   *</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment">   * @param raw_name_to_append</span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">   *        Thing to append.</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">   */</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">operator+=</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* raw_name_to_append);</div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span> </div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span> </div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span>  <span class="comment">// Friend for access to Shared_name.</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span>  <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code hl_friend" href="classipc_1_1util_1_1Shared__name.html#a9ea22a64cfbc6de66181c278ff5f6975">swap</a>(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; val1, <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; val2);</div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span> </div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment"></span> </div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   * The name or name fragment; see str().</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   * @todo Consider providing a ref-to-mutable accessor to Shared_name::m_raw_name (or just make `public`).</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   * There are pros and cons; the basic pro being that Shared_name is meant to be a very thin wrapper around</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   * `std::string`, so it might make sense to allow for in-place modification without supplying some kind of reduced</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * subset of `string` API.  Suggest doing this to-do if a practical desire comes about.</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   */</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">  659</a></span>  std::string <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">m_raw_name</a>;</div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span>}; <span class="comment">// class Shared_name</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span> </div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span> </div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span> </div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Input_it&gt;</div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a766b98e1a87f4035b6869c78f331c69a">  667</a></span><a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1f9b706d587b49ad84b555817c001fc8">Shared_name::Shared_name</a>(Input_it begin, Input_it end) :</div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span>  m_raw_name(begin, end) <span class="comment">// Copy it.</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span>{</div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span>  <span class="comment">// Nothing.</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span>}</div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span> </div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">  674</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">Shared_name::ct</a>(<span class="keyword">const</span> Source&amp; src) <span class="comment">// Static.</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span>{</div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> result;</div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span> </div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span>  <span class="comment">/* As advertised: invoke whatever `string` ctor best applies.  Well, actually, to avoid needing to move-assign</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span><span class="comment">   * (which involves a few scalar copies), use .assign() instead; but its complement of overloads equals that</span></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span><span class="comment">   * of the relevant complement of ctor overloads. */</span></div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span>  result.<a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">m_raw_name</a>.assign(src);</div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span> </div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span>  <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span>}</div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span> </div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#ae168cc42213bf7972d17bbbc1e16f2a2">  687</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">Shared_name::operator+=</a>(<span class="keyword">const</span> Source&amp; raw_name_to_append)</div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span>{</div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span>  <span class="comment">// Existence/impl rationale: This is faster than if they had to: `+= Shared_name::ct(raw_name_to_append)`.</span></div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span> </div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span>  <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">m_raw_name</a> += raw_name_to_append;</div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span>}</div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span> </div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a762bda2d73b31c9427c05c7c1a7abbcb">  696</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a956fdac1bb4cfab414b30091bec43f70">Shared_name::operator/=</a>(<span class="keyword">const</span> Source&amp; raw_name_to_append)</div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span>{</div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span>  <span class="comment">// Existence/impl rationale: This is faster than if they had to: `/= Shared_name::ct(raw_name_to_append)`.</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span> </div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span>  <span class="comment">/* m_raw_name.reserve(m_raw_name.size() + 1 + raw_name_to_append.size()); // Tiny optimization, as 2 appends follow.</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   * Oops; can&#39;t do that; `Source` could be, e.g., `char`.  @todo Reconsider. */</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span> </div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span>  <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">m_raw_name</a> += <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a5c0910497c5ec484d3e42dfb0ccad48d">S_SEPARATOR</a>;</div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">operator+=</a>(raw_name_to_append);</div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span>}</div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span> </div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a52b2ba03d5ace7389991bb5d31b9fa59">  708</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1util.html#af61b02fd66b67aeed5a803ca47e52973">operator+</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src1, <span class="keyword">const</span> Source&amp; raw_src2)</div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span>{</div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span>  <span class="comment">// Existence/impl rationale: This is faster than if they had to: `src1 + Shared_name::ct(raw_src2)`.</span></div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span> </div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span>  <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>(src1) += raw_src2;</div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span>}</div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span> </div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a1f1a40877cc08b287f8f3c7e7f663782">  716</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1util.html#af61b02fd66b67aeed5a803ca47e52973">operator+</a>(<span class="keyword">const</span> Source&amp; raw_src1, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src2)</div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span>{</div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span>  <span class="comment">// Existence rationale: For symmetry with overload: (src1, raw_src2).</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span> </div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">Shared_name::ct</a>(raw_src1) += src2;</div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span>}</div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span> </div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a910207a2da57b61cee4a22899e239dc2">  724</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1util.html#aa61c6b31c5c4e241c97f06a4d38c76c4">operator/</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src1, <span class="keyword">const</span> Source&amp; raw_src2)</div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span>{</div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span>  <span class="comment">// Existence/impl rationale: This is faster than if they had to: `src1 / Shared_name::ct(raw_src2)`.</span></div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span> </div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span>  <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>(src1) /= raw_src2;</div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span>}</div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span> </div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Source&gt;</div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Shared__name.html#a462b81d34ba23c968f63d9805fa74538">  732</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1util.html#aa61c6b31c5c4e241c97f06a4d38c76c4">operator/</a>(<span class="keyword">const</span> Source&amp; raw_src1, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; src2)</div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span>{</div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span>  <span class="comment">// Existence rationale: For symmetry with overload: (src1, raw_src2).</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span> </div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">Shared_name::ct</a>(raw_src1) /= src2;</div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span>}</div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span> </div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_<span class="keywordtype">object</span>, <span class="keyword">typename</span> Filter_func&gt;</div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a150051ee7e308ba7c9269b2d1e2c6c37">  740</a></span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a150051ee7e308ba7c9269b2d1e2c6c37">remove_each_persistent_if</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> Filter_func&amp; filter_func)</div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span>{</div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span>  <span class="comment">// This is pretty much completely described by the doc header; so keeping comments light.</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span> </div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> err_code;</div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count = 0;</div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span> </div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span>  Persistent_object::for_each_persistent([&amp;](<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name)</div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span>  {</div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span>    <span class="keywordflow">if</span> (filter_func(name))</div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span>    {</div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span>      Persistent_object::remove_persistent(logger_ptr, name, &amp;err_code);</div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span>      <span class="keywordflow">if</span> (!err_code)</div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span>      {</div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span>        ++count;</div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span>      }</div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span>      <span class="comment">// else { Probably permission error; but regardless just move past it as advertised. }</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span>    }</div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span>  });</div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span> </div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span>  <span class="keywordflow">return</span> count;</div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span>} <span class="comment">// remove_each_persistent_if()</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span> </div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_<span class="keywordtype">object</span>&gt;</div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#ad6be904bf1b0fe6659a11dec0fabbf6b">  764</a></span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_function" href="namespaceipc_1_1util.html#ad6be904bf1b0fe6659a11dec0fabbf6b">remove_each_persistent_with_name_prefix</a>(flow::log::Logger* logger_ptr,</div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span>                                                     <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name_prefix_or_empty)</div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span>{</div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a>;</div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span> </div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_TRANSPORT);</div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;Will attempt to remove-persistent objects (type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(Persistent_object).name() &lt;&lt; <span class="stringliteral">&quot;]) with &quot;</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span>                 <span class="stringliteral">&quot;prefix [&quot;</span> &lt;&lt; name_prefix_or_empty.<a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ae89e1e061f87ffe0288514e254837595">str</a>() &lt;&lt; <span class="stringliteral">&quot;] (&lt;-- may be blank; then all are removed).&quot;</span>);</div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span> </div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a> name_prefix_view(name_prefix_or_empty.<a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ae89e1e061f87ffe0288514e254837595">str</a>());</div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span>  <span class="keyword">const</span> <span class="keyword">auto</span> count = remove_each_persistent_if&lt;Persistent_object&gt;(get_logger(), [&amp;](<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name)</div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span>  {</div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span>    <span class="keywordflow">return</span> name_prefix_view.empty() || <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a>(name.<a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ae89e1e061f87ffe0288514e254837595">str</a>()).starts_with(name_prefix_view);</div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span>  });</div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span> </div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span>  <span class="keywordflow">if</span> (count != 0)</div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span>  {</div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span>    FLOW_LOG_INFO(<span class="stringliteral">&quot;Removed-persistent successfully [&quot;</span> &lt;&lt; count &lt;&lt; <span class="stringliteral">&quot;] objects &quot;</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span>                  <span class="stringliteral">&quot;(type [&quot;</span> &lt;&lt; <span class="keyword">typeid</span>(Persistent_object).name() &lt;&lt; <span class="stringliteral">&quot;]) with &quot;</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span>                  <span class="stringliteral">&quot;prefix [&quot;</span> &lt;&lt; name_prefix_or_empty &lt;&lt; <span class="stringliteral">&quot;] (&lt;-- may be blank; then all were potentially removed).  &quot;</span></div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span>                  <span class="stringliteral">&quot;Note this counts only successful removals (not ones that failed due to permissions, say).  &quot;</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span>                  <span class="stringliteral">&quot;Details potentially logged above (including any errors which are otherwise ignored).&quot;</span>);</div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span>  }</div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span> </div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span>  <span class="keywordflow">return</span> count;</div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span>} <span class="comment">// remove_each_persistent_with_name_prefix()</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span> </div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a03d90faae35392c8bbdd22f056755ba9"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a03d90faae35392c8bbdd22f056755ba9">ipc::util::Shared_name::sanitized</a></div><div class="ttdeci">bool sanitized() const</div><div class="ttdoc">Returns true if and only if the contained name/fragment is sanitized according to length,...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00175">shared_name.cpp:175</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a0bccc73c9c5b4f3b784a1e57cdc5c910"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a0bccc73c9c5b4f3b784a1e57cdc5c910">ipc::util::Shared_name::native_str</a></div><div class="ttdeci">const char * native_str() const</div><div class="ttdoc">Returns (sans copying) pointer to NUL-terminated wrapped name string, suitable to pass into sys calls...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00145">shared_name.cpp:145</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a1511bd84d701dd866029d0f4c8869516"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a1511bd84d701dd866029d0f4c8869516">ipc::util::Shared_name::operator=</a></div><div class="ttdeci">Shared_name &amp; operator=(Shared_name &amp;&amp;src_moved)</div><div class="ttdoc">Move-assigns from an existing Shared_name.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a1bcac1c10e01ba11dcc437b3c32bbe6c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a1bcac1c10e01ba11dcc437b3c32bbe6c">ipc::util::Shared_name::operator+=</a></div><div class="ttdeci">Shared_name &amp; operator+=(const Shared_name &amp;src_to_append)</div><div class="ttdoc">Appends the given other Shared_name.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00077">shared_name.cpp:77</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a1e9cad5a94d78e1180a9e77877009873"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a1e9cad5a94d78e1180a9e77877009873">ipc::util::Shared_name::Shared_name</a></div><div class="ttdeci">Shared_name(const Shared_name &amp;src)</div><div class="ttdoc">Copy-constructs from an existing Shared_name.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a1f9b706d587b49ad84b555817c001fc8"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a1f9b706d587b49ad84b555817c001fc8">ipc::util::Shared_name::Shared_name</a></div><div class="ttdeci">Shared_name()</div><div class="ttdoc">Constructs empty() name.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a43205a00865429c1bef6c7896816bf5c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">ipc::util::Shared_name::S_SENTINEL</a></div><div class="ttdeci">static const Shared_name S_SENTINEL</div><div class="ttdoc">A Shared_name fragment, with no S_SEPARATOR characters inside, that represents a path component that ...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00280">shared_name.hpp:280</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a48f20b7b54490aa10dc64081d34c55b2"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">ipc::util::Shared_name::ct</a></div><div class="ttdeci">static Shared_name ct(const Source &amp;src)</div><div class="ttdoc">Copy-constructs from a char-sequence container (including string, util::String_view,...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00674">shared_name.hpp:674</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a4c294e23753eb706b4c297d99d24cd48"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a4c294e23753eb706b4c297d99d24cd48">ipc::util::Shared_name::S_RESOURCE_TYPE_ID_SHM</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID_SHM</div><div class="ttdoc">Relative-folder fragment (no separators) identifying the resource type for: SHM pools.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00312">shared_name.hpp:312</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a4ebeee7fd046ca6ad405af6183dfb790"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a4ebeee7fd046ca6ad405af6183dfb790">ipc::util::Shared_name::m_raw_name</a></div><div class="ttdeci">std::string m_raw_name</div><div class="ttdoc">The name or name fragment; see str().</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00659">shared_name.hpp:659</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a50cb5d2ad8f8b4391e1885e7b8f63890"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a50cb5d2ad8f8b4391e1885e7b8f63890">ipc::util::Shared_name::S_RESOURCE_TYPE_ID_MUTEX</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID_MUTEX</div><div class="ttdoc">Relative-folder fragment (no separators) identifying the resource type for: boost....</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00315">shared_name.hpp:315</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a5bbfb4d3b378cf7b9a1bcaf5d6c5a067"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a5bbfb4d3b378cf7b9a1bcaf5d6c5a067">ipc::util::Shared_name::S_EMPTY</a></div><div class="ttdeci">static const Shared_name S_EMPTY</div><div class="ttdoc">A (default-cted) Shared_name. May be useful for functions returning const Shared_name&amp;.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00247">shared_name.hpp:247</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a5c0910497c5ec484d3e42dfb0ccad48d"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a5c0910497c5ec484d3e42dfb0ccad48d">ipc::util::Shared_name::S_SEPARATOR</a></div><div class="ttdeci">static const char S_SEPARATOR</div><div class="ttdoc">Character we use, by convention, to separate conceptual folders within str().</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00266">shared_name.hpp:266</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a774e872b51100b728e0780b39f563ed9"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a774e872b51100b728e0780b39f563ed9">ipc::util::Shared_name::has_trailing_separator</a></div><div class="ttdeci">bool has_trailing_separator() const</div><div class="ttdoc">Returns true if and only if !this-&gt;empty(), and str() ends with the S_SEPARATOR character.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00160">shared_name.cpp:160</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a79995ab36be778bb2a56eeba80a7abed"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a79995ab36be778bb2a56eeba80a7abed">ipc::util::Shared_name::Shared_name</a></div><div class="ttdeci">Shared_name(Shared_name &amp;&amp;src_moved)</div><div class="ttdoc">Move-constructs from an existing Shared_name, which is made empty() if not already so.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a8328c9a6bc2739145087515ee8e677d8"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a8328c9a6bc2739145087515ee8e677d8">ipc::util::Shared_name::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Makes it so empty() == true.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00170">shared_name.cpp:170</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a861ea6c9ad6672e83bab5c7747b66f7b"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a861ea6c9ad6672e83bab5c7747b66f7b">ipc::util::Shared_name::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdoc">Returns true if and only if str().empty() == true.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00155">shared_name.cpp:155</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a956fdac1bb4cfab414b30091bec43f70"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a956fdac1bb4cfab414b30091bec43f70">ipc::util::Shared_name::operator/=</a></div><div class="ttdeci">Shared_name &amp; operator/=(const Shared_name &amp;src_to_append)</div><div class="ttdoc">Appends a folder separator followed by the given other Shared_name.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00091">shared_name.cpp:91</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a9ea22a64cfbc6de66181c278ff5f6975"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a9ea22a64cfbc6de66181c278ff5f6975">ipc::util::Shared_name::swap</a></div><div class="ttdeci">friend void swap(Shared_name &amp;val1, Shared_name &amp;val2)</div><div class="ttdoc">Swaps two objects.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00420">shared_name.cpp:420</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_aaa78ddb3efa5abe4fa80058dedbef68c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#aaa78ddb3efa5abe4fa80058dedbef68c">ipc::util::Shared_name::S_1ST_OR_ONLY</a></div><div class="ttdeci">static const Shared_name S_1ST_OR_ONLY</div><div class="ttdoc">A Shared_name fragment, with no S_SEPARATOR characters inside, that represents a path component that ...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00309">shared_name.hpp:309</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_ab1934f80515fdbc3e2a59ccda32fff9a"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#ab1934f80515fdbc3e2a59ccda32fff9a">ipc::util::Shared_name::absolute</a></div><div class="ttdeci">bool absolute() const</div><div class="ttdoc">Returns true if and only if the first character is S_SEPARATOR.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00165">shared_name.cpp:165</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_abd312f9eaf6f07adaba115aaab05b539"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#abd312f9eaf6f07adaba115aaab05b539">ipc::util::Shared_name::operator=</a></div><div class="ttdeci">Shared_name &amp; operator=(const Shared_name &amp;src)</div><div class="ttdoc">Copy-assigns from an existing Shared_name.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_add4ed045e03f786427a236a5dfa5a1b0"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#add4ed045e03f786427a236a5dfa5a1b0">ipc::util::Shared_name::sanitize</a></div><div class="ttdeci">bool sanitize()</div><div class="ttdoc">Best-effort attempt to turn sanitized() from false to true, unless it is already true; returns the fi...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00221">shared_name.cpp:221</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_ae89e1e061f87ffe0288514e254837595"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#ae89e1e061f87ffe0288514e254837595">ipc::util::Shared_name::str</a></div><div class="ttdeci">const std::string &amp; str() const</div><div class="ttdoc">Returns (sans copying) ref to immutable entire wrapped name string, suitable to pass into sys calls w...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00140">shared_name.cpp:140</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_af08b45aa719d4f5dced595cca39ab2c8"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#af08b45aa719d4f5dced595cca39ab2c8">ipc::util::Shared_name::S_ROOT_MAGIC</a></div><div class="ttdeci">static const Shared_name S_ROOT_MAGIC</div><div class="ttdoc">A Shared_name fragment, with no S_SEPARATOR characters inside, to be used in any Shared_name maintain...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00272">shared_name.hpp:272</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_af34db2934e116f8a4fdd403fd04695af"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#af34db2934e116f8a4fdd403fd04695af">ipc::util::Shared_name::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Returns str().size().</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00150">shared_name.cpp:150</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_afc9b87fc69d42df3107bf4a27ea66c7c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#afc9b87fc69d42df3107bf4a27ea66c7c">ipc::util::Shared_name::S_MAX_LENGTH</a></div><div class="ttdeci">static const size_t S_MAX_LENGTH</div><div class="ttdoc">Max value of size() such that, if str() used to name a supported shared resource, sys call safely won...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00263">shared_name.hpp:263</a></div></div>
<div class="ttc" id="acommon_8hpp_html"><div class="ttname"><a href="common_8hpp.html">common.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_html_a33de1c256addb3964b839dc2dd407d24"><div class="ttname"><a href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">ipc::transport::Shared_name</a></div><div class="ttdeci">util::Shared_name Shared_name</div><div class="ttdoc">Convenience alias for the commonly used type util::Shared_name.</div><div class="ttdef"><b>Definition:</b> <a href="transport__fwd_8hpp_source.html#l00084">transport_fwd.hpp:84</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a150051ee7e308ba7c9269b2d1e2c6c37"><div class="ttname"><a href="namespaceipc_1_1util.html#a150051ee7e308ba7c9269b2d1e2c6c37">ipc::util::remove_each_persistent_if</a></div><div class="ttdeci">unsigned int remove_each_persistent_if(flow::log::Logger *logger_ptr, const Filter_func &amp;filter_func)</div><div class="ttdoc">Utility that invokes Persistent_object::for_each_persistent(name_prefix_or_empty) and synchronously i...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00740">shared_name.hpp:740</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aa61c6b31c5c4e241c97f06a4d38c76c4"><div class="ttname"><a href="namespaceipc_1_1util.html#aa61c6b31c5c4e241c97f06a4d38c76c4">ipc::util::operator/</a></div><div class="ttdeci">Shared_name operator/(const Shared_name &amp;src1, const char *raw_src2)</div><div class="ttdoc">Returns new object equal to Shared_name(src1) /= raw_src2.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00119">shared_name.cpp:119</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ad6be904bf1b0fe6659a11dec0fabbf6b"><div class="ttname"><a href="namespaceipc_1_1util.html#ad6be904bf1b0fe6659a11dec0fabbf6b">ipc::util::remove_each_persistent_with_name_prefix</a></div><div class="ttdeci">unsigned int remove_each_persistent_with_name_prefix(flow::log::Logger *logger_ptr, const Shared_name &amp;name_prefix_or_empty)</div><div class="ttdoc">Utility that invokes remove_each_persistent_if() with the filter that returns true (yes,...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00764">shared_name.hpp:764</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_af61b02fd66b67aeed5a803ca47e52973"><div class="ttname"><a href="namespaceipc_1_1util.html#af61b02fd66b67aeed5a803ca47e52973">ipc::util::operator+</a></div><div class="ttdeci">Shared_name operator+(const Shared_name &amp;src1, const char *raw_src2)</div><div class="ttdoc">Returns new object equal to Shared_name(src1) += raw_src2.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00097">shared_name.cpp:97</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="ashared__name__fwd_8hpp_html"><div class="ttname"><a href="shared__name__fwd_8hpp.html">shared_name_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
